Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs on renaming existing package #40171

Merged
merged 2 commits into from
Jul 3, 2021
Merged

Conversation

ericphanson
Copy link
Member

@ericphanson ericphanson commented Jul 3, 2021

To mention the old package's URL should be updated. cc @oxinabox who wrote the original version

To mention the old package's URL should be updated.
@ericphanson ericphanson temporarily deployed to stopwatch July 3, 2021 15:52 Inactive
@DilumAluthge
Copy link
Member

@ericphanson @oxinabox Is this good to merge?

@ericphanson
Copy link
Member Author

I think so. Do you think the link is OK? That was the only PR I could find which actually did the thing I suggest to do here, but the main PR body has a lot of discussion which I thought could confuse people.

@DilumAluthge
Copy link
Member

Hmmm. Maybe pick a simpler PR?

@DilumAluthge
Copy link
Member

Or just omit the PR link. I agree that the discussion in that PR will probably be overwhelming and not terribly useful.

README.md Outdated

- Follow the instructions above for renaming a package: rename on GitHub, rename files etc.
- if you rename the repository so it has a new URL, make a PR to edit the URL stored in the
registry for the old package name to point to the new URL ([example](https://github.com/JuliaRegistries/General/pull/11578/files)).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
registry for the old package name to point to the new URL ([example](https://github.com/JuliaRegistries/General/pull/11578/files)).
registry for the old package name to point to the new URL.

@ericphanson
Copy link
Member Author

ericphanson commented Jul 3, 2021

These are the repos whose URL in the registry redirects to another URL (ignoring .git ending differences):

original_repo final_repo
https://github.com/sunoru/RandomNumbers.jl.git https://github.com/JuliaRandom/RandomNumbers.jl
https://github.com/christopher-dG/GitForge.jl.git https://github.com/JuliaWeb/GitForge.jl
https://github.com/zekeriyasari/Jusdl.jl.git (#40190) https://github.com/zekeriyasari/Causal.jl
https://github.com/kul-forbes/ProximalOperators.jl.git (#40192) https://github.com/kul-optec/ProximalOperators.jl
https://github.com/logankilpatrick/Slack.jl.git (#40193) https://github.com/JuliaLangSlack/Slack.jl

(edit: crossed-out ones which have already been updated).

as of a couple weeks ago when I ran

get_url_after_redirect(url) = readchomp(`curl -ILs -o /dev/null -w %\{url_effective\} $url`)

# GitHub does not like this and will block you temporarily:
repo_redirects_df = let
	repo_redirects_df = DataFrame(:original_repo => unique(df.repo))
	repo_redirects_df.final_repo = asyncmap(get_url_after_redirect, repo_redirects_df.original_repo)
	repo_redirects_df
end

Arrow.write("repo_redirects.arrow", repo_redirects_df)

and got suspended from GitHub for a day for not rate-limiting when preparing my JuliaCon talk with Mosè about how many packages have docs/tests/ci/license/# lines of code/etc in General.

Of those, only one is a rename (Jusdl to Causal). So I will just make the PR to do the rename, and then link to that PR here 😄.

README.md Outdated Show resolved Hide resolved
@ericphanson ericphanson temporarily deployed to stopwatch July 3, 2021 22:49 Inactive
@ericphanson ericphanson temporarily deployed to stopwatch July 3, 2021 22:49 Inactive
@ericphanson ericphanson merged commit 6fd5166 into master Jul 3, 2021
@ericphanson ericphanson deleted the eph/update-rename-docs branch July 3, 2021 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants